| Package | csiro.fhir.au.smartforms |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | https://smartforms.csiro.au/ig/https://build.fhir.org/ig/aehrc/smart-forms-ig/CapabilityStatement-SmartFormsServer.html |
| Url | https://smartforms.csiro.au/ig/CapabilityStatement/SmartFormsServer |
| Version | 0.2.0 |
| Status | draft |
| Date | 2023-06-16 |
| Name | SmartFormsServer |
| Title | Smart Forms Server |
| Experimental | False |
| Description | This CapabilityStatement describes the capabilities of the Smart Forms Server. The Smart Forms Server provides a definitional repository of resources that a client application can retrieve for use in a Smart Forms context. The capabilities listed include supported FHIR profiles, RESTful operations, and search parameters. |
| Copyright | Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/. |
| Kind | capability |
No resources found
| CapabilityStatement | |
http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager  | SDC Form Manager |
| http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager | SDC Form Manager |
| http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-assemble | Assemble Modular Questionnaire Operation |
| http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-assemble | Assemble Modular Questionnaire Operation |
| http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-modular | SDC Modular Questionnaire |
| http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-modular | SDC Modular Questionnaire |
Note: links and images are rebased to the (stated) source
FHIRjson and xmlNote to Implementers: FHIR Capabilities
Additional FHIR capabilities may be 'allowed' by the system. Only the capabilities relevant to Smart Forms have been included in this capability statement.
serverThe Smart Forms Server provides interactions for hosting Questionnaire resources and the assembly of modular Questionnaires.
- TBD requirements and deployment considerations.
- See the Structured Data Capture Security Details section for general considerations and recommendations.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Questionnaire | http://hl7.org/fhir/StructureDefinition/Questionnaire Additional supported profiles: | y | y | url, version, title, _count, _sort, url+version, _count+_sort, title+_count+_sort | $assemble |
read, search-type.| Operation | Documentation |
|---|---|
| $assemble | |
{
"resourceType" : "CapabilityStatement",
"id" : "SmartFormsServer",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"> <h2>Smart Forms Server Capability Statement</h2> <ul> <li>Kind of capability statement: capability</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>json</code> and <code>xml</code></li><li>Published by: AEHRC CSIRO</li></ul> <blockquote class=\"impl-note\"> <p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Additional FHIR capabilities may be 'allowed' by the system. Only the capabilities relevant to Smart Forms have been included in this capability statement.</p></blockquote> <h3 id=\"CSs\">Implements a Subset of the Following Capability Statements:</h3> <ul> <li><a href=\"http://hl7.org/fhir/uv/sdc/STU3/CapabilityStatement-sdc-form-manager.html\">SDC Form Manager</a> </li></ul> <h2 id=\"rest\">FHIR RESTful Capabilities</h2> <div class=\"panel panel-default\"> <div class=\"panel-heading\"> <h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3> </div><div class=\"panel-body\"> <div> <p>The Smart Forms Server provides interactions for hosting Questionnaire resources and the assembly of modular Questionnaires.</p></div><div class=\"lead\"><em>Security</em></div><blockquote> <div> <ul><li>TBD requirements and deployment considerations.</li><li>See the <a href=\"http://hl7.org/fhir/uv/sdc/STU3/security.html\">Structured Data Capture Security Details</a> section for general considerations and recommendations.</li></ul> <p/></div></blockquote> </div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3> <h4 id=\"resourcesSummary1\">Summary</h4> <p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul> <li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul> <div class=\"table-responsive\"> <table class=\"table table-condensed table-hover\"> <thead> <tr> <th><b>Resource Type</b></th> <th><b>Profile</b></th> <th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th> <th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th> <th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th> <th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th> <th><b title=\"Required and recommended search parameters\">Searches</b></th> <th><code><b>_include</b></code></th> <th><code><b>_revinclude</b></code></th> <th><b>Operations</b></th> </tr></thead> <tbody> <tr> <td><a href=\"#Questionnaire1\">Questionnaire</a></td><td><a href=\"http://hl7.org/fhir/R4/questionnaire.html\">http://hl7.org/fhir/StructureDefinition/Questionnaire</a><br/> <em>Additional supported profiles:</em> <ul> <li><a href=\"http://hl7.org/fhir/uv/sdc/STU3/StructureDefinition-sdc-questionnaire.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</a></li><li><a href=\"http://hl7.org/fhir/uv/sdc/STU3/StructureDefinition-sdc-questionnaire-modular.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-modular</a> </li></ul> </td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>url, version, title, _count, _sort, url+version, _count+_sort, title+_count+_sort</td><td/> <td/><td><code>$assemble</code></td></tr></tbody> </table> </div><hr/> <div class=\"panel panel-default\"> <div class=\"panel-heading\"> <h4 id=\"Questionnaire1\" class=\"panel-title\">Questionnaire</h4> </div><div class=\"panel-body\"> <div class=\"container\"> <div class=\"row\"> <div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/questionnaire.html\">http://hl7.org/fhir/StructureDefinition/Questionnaire</a> </div></div><p/> <div class=\"row\"> <div class=\"col-6\"><span class=\"lead\">Supported Profiles</span> <ul> <li><a href=\"http://hl7.org/fhir/uv/sdc/STU3/StructureDefinition-sdc-questionnaire.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</a> </li><li><a href=\"http://hl7.org/fhir/uv/sdc/STU3/StructureDefinition-sdc-questionnaire-modular.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-modular</a> </li></ul> </div></div><div class=\"row\"> <div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/> <ul> <li>Supports <code>read</code>, <code>search-type</code>.</li></ul> </div></div><p/> <div class=\"row\"> <div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span> <table class=\"table table-condensed table-hover\"> <thead> <tr> <th>Parameter</th> <th>Type</th> <th>Documentation</th> </tr></thead> <tbody> <tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">url</a></td><td><code>uri</code></td><td> <div> <p/></div></td></tr><tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">version</a></td><td><code>token</code></td><td> <div> <p/></div></td></tr><tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">title</a></td><td><code>string</code></td><td> <div> <p>The server supports search using the :contains modifier.</p></div></td></tr><tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">_count</a></td><td><code>number</code></td><td> <div> <p>The server supports search result limiting.</p></div></td></tr><tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">_sort</a></td><td><code>string</code></td><td> <div> <p>The server supports search result sorting by date and <strong>MAY</strong> support other values.</p></div></td></tr></tbody> </table> </div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span> <table class=\"table table-condensed table-hover\"> <thead> <tr> <th>Parameters</th> <th>Types</th> </tr></thead> <tbody> <tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">url</a>+ <a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">version</a> </td><td><code>uri</code>+<code>token</code></td></tr><tr> <td><a href=\"http://hl7.org/fhir/R4/search.html#count\">_count</a>+ <a href=\"http://hl7.org/fhir/R4/search.html#_sort\">_sort</a> </td><td><code>number</code>+<code>string</code></td></tr><tr> <td><a href=\"http://hl7.org/fhir/R4/questionnaire.html#search\">title</a>+ <a href=\"http://hl7.org/fhir/R4/search.html#count\">_count</a>+ <a href=\"http://hl7.org/fhir/R4/search.html#_sort\">_sort</a> </td><td><code>string</code>+<code>number</code>+<code>string</code></td></tr></tbody> </table> </div></div><div class=\"row\"> <div class=\"col-12\"><span class=\"lead\">Operations</span> <table class=\"table table-condensed table-hover\"> <thead> <tr> <th>Operation</th> <th>Documentation</th> </tr></thead> <tbody> <tr> <td><a href=\"http://hl7.org/fhir/uv/sdc/STU3/OperationDefinition-Questionnaire-assemble.html\">$assemble</a></td><td> <div> <p/></div></td></tr></tbody> </table> </div></div></div></div></div></div>"
},
"url" : "https://smartforms.csiro.au/ig/CapabilityStatement/SmartFormsServer",
"version" : "0.2.0",
"name" : "SmartFormsServer",
"title" : "Smart Forms Server",
"status" : "draft",
"experimental" : false,
"date" : "2023-06-16",
"publisher" : "AEHRC CSIRO",
"contact" : [
{
"name" : "AEHRC CSIRO",
"telecom" : [
{
"system" : "url",
"value" : "https://confluence.csiro.au/display/PCDQFPhase2/Primary+Care+Data+Quality+Foundations+-+Phase+2"
}
]
}
],
"description" : "This CapabilityStatement describes the capabilities of the Smart Forms Server. The Smart Forms Server provides a definitional repository of resources that a client application can retrieve for use in a Smart Forms context. The capabilities listed include supported FHIR profiles, RESTful operations, and search parameters.",
"copyright" : "Copyright © 2022+ Australian Government Department of Health and Aged Care - All rights reserved. This content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See https://creativecommons.org/licenses/by-sa/4.0/.",
"kind" : "capability",
"instantiates" : [
"http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager"
],
"software" : {
"name" : "Smart Forms Server"
},
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The Smart Forms Server provides interactions for hosting Questionnaire resources and the assembly of modular Questionnaires.",
"resource" : [
{
"extension" : [
{
"extension" : [
{
"url" : "required",
"valueString" : "url"
},
{
"url" : "required",
"valueString" : "version"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "_count"
},
{
"url" : "required",
"valueString" : "_sort"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "title"
},
{
"url" : "required",
"valueString" : "_count"
},
{
"url" : "required",
"valueString" : "_sort"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Questionnaire",
"profile" : "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"supportedProfile" : [
"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-modular"
],
"interaction" : [
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type" : "uri"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type" : "token"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type" : "string",
"documentation" : "<div> <p>The client supports search using the :contains modifier.</p></div>"
},
{
"name" : "_count",
"type" : "number",
"documentation" : "<div> <p>The server supports search result limiting.</p></div>"
},
{
"name" : "_sort",
"type" : "string",
"documentation" : "<div> <p>The server supports search result sorting by date and <strong>MAY</strong> support other values.</p></div>"
}
],
"operation" : [
{
"name" : "assemble",
"definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-assemble"
}
]
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.